Docs/update reference to JS build setup 404 in scripts README, fix absolute links. #69495
Conversation
dontfeedthecode
requested review from
gziolo,
ntwb,
nerrad,
ajitbohra and
ryanwelcher
as code owners
|
The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message. To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook. |
github-actions
bot
added
the
First-time Contributor
|
👋 Thanks for your first Pull Request and for helping build the future of Gutenberg and WordPress, @dontfeedthecode! In case you missed it, we'd love to have you join us in our Slack community. If you want to learn more about WordPress development in general, check out the Core Handbook full of helpful information. |
What?
Closes #69494
Fixing the 404 within the README for JavaScript Build Setup tutorial to go to the corresponding, correct URL referenced in WordPress Developer Resources
What?
When viewing the scripts package README the link to JavaScript Build Setup tutorial within the Setup section leads to a 404. In addition, all links referencing the Gutenberg repository in this README had absolute paths including the GitHub URL.
Why?
The link to JavaScript Build Setup tutorial should lead to a valid URL. Absolute paths containing the GitHub URL contravenes the Using Links section of the contributor guidelines.
How?
There is a reference to this outdated JavaScript Build Setup tutorial URL in the WordPress Developer Resources how-to guides. A decision to redirect this link to https://developer.wordpress.org/block-editor/getting-started/fundamentals/javascript-in-the-block-editor/ had already been made in the past, I've updated the link in the README accordingly.
All links to the Gutenberg repo (including the updated link referenced above) have had their URL's updated to remove the domain, e.g.
https://github.com/WordPress/gutenberg/blob/HEAD/packages/scripts/CHANGELOG.mdbecomes/packages/scripts/CHANGELOG.md.Testing Instructions
The link pictured below should now say "Working with JavaScript for the Block Editor" which is the correct page title for the updated URL and no longer lead you to a 404 page.
There should be no absolute references to
https://github.com/WordPress/gutenberg/blob/*orhttps://github.com/WordPress/gutenberg/tree/*in links within the README.